Skip to content

Clarify Table 1 and hyperlink documentation references - #204

Merged
neuromechanist merged 2 commits into
mainfrom
docs/hyperlink-documentation
Jul 20, 2026
Merged

Clarify Table 1 and hyperlink documentation references#204
neuromechanist merged 2 commits into
mainfrom
docs/hyperlink-documentation

Conversation

@neuromechanist

Copy link
Copy Markdown
Member

Two reader-facing clarity fixes on paper.md.

Table 1 was unreadable

The "Result (mean)" column packed two metrics on two datasets into cryptic delimited cells: "0.998 / 0.006" (the reader can't tell 0.998 is Hungarian-matched correlation and 0.006 is Amari distance), and $k$ jumped between 153 and 30 with no explanation (they are two different recordings). Restructured so each metric gets its own row, is named, and states its dataset and $k$; the caption now explains that the correlation headline uses the well-determined external recording ($k\approx153$) while the Amari/score-function checks use the bundled sample ($k\approx30$). No more "/" decoding or unexplained $k$. (Also removed the text/caption duplication of the $k$ definition.)

Bare "(documentation)" not hyperlinked

The four "(documentation)" references were plain text (or only the raw URL was linked). All four now hyperlink the word to the validation guide (https://eeglab.org/pAMICA/guides/validation/).

Body 1570 words, no em-dashes; Draft PDF CI validates the build.

@neuromechanist
neuromechanist merged commit 8556f38 into main Jul 20, 2026
@neuromechanist
neuromechanist deleted the docs/hyperlink-documentation branch July 20, 2026 05:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant